Skip to content

docs: refonte Get Started navigation, retire AI Builder Portal, docum… - #186

Merged
jul-dan merged 20 commits into
mainfrom
docs-new-messaging-and-agent-tasks
Sep 16, 2026
Merged

jul-dan merged 20 commits into
mainfrom
docs-new-messaging-and-agent-tasks

Conversation

@jul-dan

@jul-dan jul-dan commented Sep 10, 2026

Copy link
Copy Markdown
Contributor
  • Remove AI Builder Portal from the product switcher (content under docs/rde/** untouched), fix the repo-wide missing-prefix link bug and other broken links across the Get Started page group
  • Fix an AWS IAM policy drift between two snippets (missing servicequotas permission, duplicate dynamodb entry) and convert aws/azure/scaleway installation guides to import their credentials snippets instead of hand- duplicating them, matching the existing gcp.mdx pattern
  • Restructure Get Started navigation: dedupe pages listed twice in docs.json, dissolve the ambiguous "Quickstart" nav group, fork Installation into Local / Managed Cluster / BYOK, rename quickstart/docker-desktop to quickstart/docker with a redirect
  • Rebuild aws.mdx onto the same section skeleton as the other three cloud providers (Overview, What Gets Created, Best Practices) and strip marketing language, emojis, and em dashes across the touched pages per AGENTS.md
  • Realign messaging on introduction.mdx and how-it-works.mdx with qovery.com's current positioning, and rewrite the migration guide around the qovery-onboard skill
  • Add Agent Tasks documentation (alpha): a Getting Started overview with the ready-made use cases, and a Configuration reference with setup, automations (schedule/webhook triggers, webhook outputs), and dedicated guides for the Incident Analyser and Build & Deployment Optimizer templates

Summary by cubic

Retires the AI Builder Portal product entry, restructures the Get Started docs, and adds Agent Tasks (alpha) documentation.

Navigation & Docs

  • Drops the navigation.products wrapper so the header no longer renders a product switcher dropdown.
  • Dedupes docs.json entries, dissolves the Quickstart group, splits Installation into Local / Managed Cluster / BYOK, and renames quickstart/docker-desktop to quickstart/docker with a redirect.
  • Fixes the repo-wide missing-prefix link bug and the AWS IAM policy drift in the credential snippets and downloadable JSON.
  • Makes AWS, Azure, and Scaleway install guides import credential snippets, rebuilds aws.mdx, and extracts the shared Qovery CLI auth snippet.
  • Realigns intro and how-it-works messaging, strips marketing language, and surfaces Migrate to Kubernetes as the first quickstart card.

Agent Tasks (Alpha)

  • Adds a Getting Started overview and Configuration reference covering setup, triggers, outputs, resources, governance, and limits.
  • Adds walkthroughs for the Incident Analyzer (incident.io and Honeybadger variants), Build & Deployment Optimizer, and Jira and Linear Coding Agents, with real brand logos.
  • Moves Agent Tasks into its own Services group with template guides nested under Examples so more can be added later.
  • Documents the automatic MCP setup (a Qovery service as context adds Qovery's MCP server automatically, org-scoped and read-only via a Viewer API token) and the manual path for remote MCP servers; API Policy Tokens can scope agent access.
  • Extracts duplicated setup steps and the early preview warning into shared snippets.

Written for commit b28d9c5. Summary will update on new commits.

Review in cubic

…ent Agent Tasks

- Remove AI Builder Portal from the product switcher (content under docs/rde/**
  untouched), fix the repo-wide missing-prefix link bug and other broken links
  across the Get Started page group
- Fix an AWS IAM policy drift between two snippets (missing servicequotas
  permission, duplicate dynamodb entry) and convert aws/azure/scaleway
  installation guides to import their credentials snippets instead of hand-
  duplicating them, matching the existing gcp.mdx pattern
- Restructure Get Started navigation: dedupe pages listed twice in docs.json,
  dissolve the ambiguous "Quickstart" nav group, fork Installation into
  Local / Managed Cluster / BYOK, rename quickstart/docker-desktop to
  quickstart/docker with a redirect
- Rebuild aws.mdx onto the same section skeleton as the other three cloud
  providers (Overview, What Gets Created, Best Practices) and strip marketing
  language, emojis, and em dashes across the touched pages per AGENTS.md
- Realign messaging on introduction.mdx and how-it-works.mdx with qovery.com's
  current positioning, and rewrite the migration guide around the
  qovery-onboard skill
- Add Agent Tasks documentation (alpha): a Getting Started overview with the
  ready-made use cases, and a Configuration reference with setup, automations
  (schedule/webhook triggers, webhook outputs), and dedicated guides for the
  Incident Analyser and Build & Deployment Optimizer templates

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@jul-dan
jul-dan requested a review from a team September 10, 2026 09:42
@mintlify

mintlify Bot commented Sep 10, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
qovery 🟢 Ready View Preview Sep 16, 2026, 8:48 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 10, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
✅ Deployment successful!
View logs
qovery-doc-mintlify-proxy b28d9c5 Sep 16 2026, 08:47 AM

navigation.products always renders a dropdown switcher in the header,
even with a single product, since that's inherent to the products
navigation type rather than tied to how many entries it has. Move the
six tabs to navigation.tabs directly, dropping the products wrapper
entirely, since there's only one product (Platform) now that AI
Builder Portal is gone.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Comment thread docs/docs.json Outdated
Comment thread docs/docs.json Outdated
Comment thread docs/configuration/agent-tasks/incident-analyser.mdx Outdated
Comment thread docs/configuration/agent-tasks/build-deployment-optimizer.mdx Outdated

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed

Tip: cubic can generate docs of your entire codebase and keep them up to date. Try it here.

Re-trigger cubic

Comment thread docs/getting-started/introduction.mdx
Comment thread docs/configuration/agent-tasks/incident-analyser.mdx Outdated
Comment thread docs/snippets/aws-credentials-static.mdx
Comment thread docs/snippets/README.md
Comment thread docs/getting-started/guides/use-cases/cloud-migration-and-scaling.mdx Outdated
Comment thread docs/getting-started/how-it-works.mdx
Comment thread docs/snippets/README.md
Comment thread docs/getting-started/guides/use-cases/cloud-migration-and-scaling.mdx Outdated
Comment thread docs/snippets/README.md
Comment thread docs/getting-started/agent-tasks.mdx Outdated
Comment thread docs/getting-started/introduction.mdx
Comment thread docs/configuration/agent-tasks/overview.mdx Outdated
- Move "Agent Tasks" out of the Jobs subcategory into its own Services
  group, and nest the two use-case guides under an "Examples" subgroup
  so more can be added over time
- Drop the literal prompt text and exact resource/domain values from
  the Incident Analyser and Build & Deployment Optimizer guides, they
  will drift as the templates change. Explain what each agent does and
  how to set it up instead

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 3 files (changes from recent commits).

Requires human review: Auto-approval blocked because this review re-detected 1 unresolved issue already reported by Cubic.
Tip: Review your code locally with the cubic CLI to iterate faster.

Re-trigger cubic

Comment thread docs/configuration/agent-tasks/build-deployment-optimizer.mdx Outdated
jul-dan and others added 3 commits September 10, 2026 13:42
docs/files/qovery-iam-aws.json still had the duplicate dynamodb:*
entry and was missing servicequotas:GetServiceQuota, the same drift
already fixed in the aws-credentials snippets. Anyone using the
"Download IAM permissions JSON" link was getting the uncorrected
policy. Caught by review.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
…intro

- how-it-works.mdx: the architecture diagram SVG still visually shows
  five product panels (never updated for Agents), so drop the numeric
  claim from its alt text instead of asserting a count the image
  doesn't show. Fix the remaining "all five products" Next Steps card
  to six. The SVG itself needs a real design update to add a sixth
  panel, out of scope here.
- getting-started/agent-tasks.mdx: its Overview paragraph was a
  verbatim copy of configuration/agent-tasks/overview.mdx's. Rewrite
  it as a lighter, product-pitch intro and point to the Configuration
  Reference for the technical definition, so there's one place that
  owns it.

Caught by review.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Comment thread docs/configuration/agent-tasks/overview.mdx
Comment thread docs/configuration/agent-tasks/overview.mdx Outdated
Comment thread docs/configuration/agent-tasks/overview.mdx Outdated
Comment thread docs/configuration/agent-tasks/overview.mdx Outdated
Comment thread docs/configuration/agent-tasks/build-deployment-optimizer.mdx
Comment thread docs/configuration/agent-tasks/incident-analyser.mdx
Co-authored-by: Rémi Bonnet <bonnet.rem@gmail.com>
jul-dan and others added 2 commits September 10, 2026 17:01
…orrections

- cloud-migration-and-scaling.mdx: qovery-onboard was credited with the
  full technical migration workflow (analyze codebase, Dockerfiles,
  databases, deploy), which contradicts this repo's own agent-skills.mdx
  and ai-agent.mdx, where that workflow belongs to qovery-deploy.
  qovery-onboard stays the right entry point (context, concept mapping,
  cluster setup), qovery-deploy now owns the execution steps
- introduction.mdx and quickstart.mdx: give the migration use case a
  "Migrate to Kubernetes" card and move it first, before "Deploy with
  AI Agent", per review feedback
- Qovery's own MCP server is not added automatically, fix the three
  places that said otherwise (agent-tasks/overview.mdx,
  agent-tasks/build-deployment-optimizer.mdx, organization.mdx) to say
  it must be added manually (https://mcp.qovery.com/mcp), and link to
  the API Policy Token doc for scoped access instead of overclaiming
  the endpoint itself is read-only
- agent-tasks/overview.mdx: reword an output example per review
  ("For example, to post...") and stop implying Agent Tasks only run
  once when schedule triggers are documented on the same page

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…y/documentation-v2 into docs-new-messaging-and-agent-tasks
jul-dan and others added 2 commits September 11, 2026 11:38
… fix

- Scope the API Policy Token mention to the Qovery MCP server
  specifically in overview.mdx and organization.mdx, it was worded as
  if it applied to any remote MCP server
- overview.mdx: add the actual entry point (environment > New Service
  > Create new service > Agent use cases) as the first step, with
  screenshots of the service picker and the agent creation form
- incident-analyser.mdx and build-deployment-optimizer.mdx: replace
  the flat "Setting It Up" bullet list with a full setup-to-first-run
  walkthrough (repository, Qovery MCP access with propose vs apply
  permissions, credentials/allowlist, trigger, and how to fire and
  verify a first run via the webhook URL), per review feedback

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…nd logos

- Add Jira Coding Agent and Linear Coding Agent tutorials: setup
  (repo, provider, optional MCP), and the trigger webhook configured
  on each platform's automation feature, with a real screenshot for
  the Jira flow
- Split Incident Analyser into two full tutorials, one for incident.io
  and one for Honeybadger, each self-contained rather than cross-
  referencing the other, with real screenshots of both platforms'
  webhook/workflow setup
- Fetch and verify real brand logos for incident.io, Honeybadger,
  Jira, and Linear from their official sources, replacing generic
  FontAwesome/placeholder icons across the Tutorials and Use Cases
  card groups
- overview.mdx: correct the MCP step (any remote MCP server first,
  Qovery's own as a secondary Info callout, not added automatically)
  and add exact Server URL / header format; add a Limits subsection
  to Execution Mode (1h execution timeout, 3-day cloned environment
  TTL, 50 iterations per run via MAX_TURNS, 60 clones/hour/org); merge
  the "Automations" abstraction into direct Triggers and Outputs
- getting-started/agent-tasks.mdx: drop the Configuration Reference
  card duplicating Start from Scratch, add a "Why Run Agent Tasks in
  Qovery" section explaining the value of running them here specifically

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 18 files (changes from recent commits).

Tip: Review your code locally with the cubic CLI to iterate faster.

Re-trigger cubic

Comment thread docs/configuration/agent-tasks/incident-analyser-honeybadger.mdx
Comment thread docs/configuration/agent-tasks/incident-analyser-honeybadger.mdx
Comment thread docs/configuration/agent-tasks/incident-analyser.mdx Outdated
Comment thread docs/configuration/agent-tasks/linear-coding-agent.mdx Outdated
Comment thread docs/getting-started/agent-tasks.mdx Outdated
Comment thread docs/configuration/agent-tasks/overview.mdx Outdated
Comment thread docs/configuration/agent-tasks/jira-coding-agent.mdx Outdated
Comment thread docs/configuration/agent-tasks/build-deployment-optimizer.mdx Outdated
Comment thread docs/configuration/agent-tasks/incident-analyser.mdx Outdated
Comment thread docs/images/logos/linear-icon.svg
Comment thread docs/configuration/agent-tasks/overview.mdx Outdated
Comment thread docs/configuration/agent-tasks/overview.mdx Outdated
Comment thread docs/configuration/agent-tasks/build-deployment-optimizer.mdx Outdated
Comment thread docs/configuration/agent-tasks/overview.mdx Outdated
Comment thread docs/getting-started/agent-tasks.mdx
Comment thread docs/configuration/agent-tasks/overview.mdx Outdated
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Show where the on-demand Trigger (play) button actually is on an
agent task's overview page, referenced from Triggers and Outputs.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
jul-dan and others added 2 commits September 16, 2026 08:46
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: Rémi Bonnet <bonnet.rem@gmail.com>

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 18 files (changes from recent commits).

Tip: Review your code locally with the cubic CLI to iterate faster.

Re-trigger cubic

Comment thread docs/getting-started/agent-tasks.mdx Outdated
Comment thread docs/configuration/agent-tasks/build-deployment-optimizer.mdx Outdated
Comment thread docs/configuration/agent-tasks/jira-coding-agent.mdx Outdated
Comment thread docs/configuration/agent-tasks/incident-analyser-honeybadger.mdx Outdated
Comment thread docs/configuration/agent-tasks/jira-coding-agent.mdx Outdated
jul-dan and others added 2 commits September 16, 2026 09:43
…word Early Preview banner

- Distinguish the automatic (Qovery service as Context -> org-scoped,
  read-only MCP via Viewer API token) MCP setup from the manual/custom
  path across overview.mdx, incident-analyser.mdx,
  incident-analyser-honeybadger.mdx, and build-deployment-optimizer.mdx.
- Split the mandatory "Add a Trigger" step from the optional "Add an
  Output" step, and fix the same optional/mandatory mislabeling in
  build-deployment-optimizer.mdx.
- Correct the Context picker's wording in getting-started/agent-tasks.mdx
  ("Add Qovery services from your environment" instead of "environments").
- Extract the verbatim-duplicated setup steps shared by
  jira-coding-agent.mdx and linear-coding-agent.mdx into
  snippets/coding-agent-{setup-steps,output-step,footer-links}.mdx.
- Extract the Early Preview warning, duplicated across 7 files, into
  snippets/agent-tasks-early-preview-warning.mdx, and reword it to read
  as a limited early preview rather than "in early development".
- Update organization.mdx's AI Settings section to match: Qovery's own
  MCP is now added automatically, not "not added automatically".
- Swap the outdated Linear icon for the current monochrome brand mark.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…y/documentation-v2 into docs-new-messaging-and-agent-tasks

# Conflicts:
#	docs/configuration/agent-tasks/build-deployment-optimizer.mdx
#	docs/configuration/agent-tasks/incident-analyser.mdx
#	docs/configuration/agent-tasks/overview.mdx
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
@jul-dan
jul-dan merged commit d6dfddc into main Sep 16, 2026
5 checks passed
@jul-dan
jul-dan deleted the docs-new-messaging-and-agent-tasks branch September 16, 2026 12:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants